oracle.AWXML
Class CalculationSpecification

java.lang.Object
  |
  +--oracle.AWXML.BaseObject
        |
        +--oracle.AWXML.CalculationSpecification

Direct Known Subclasses:

Aggregation, ModelRef

public abstract class CalculationSpecification

extends BaseObject

An abstract class that specifies how to aggregate data over a dimension. A CalculationSpecification is owned by an AggregationDefinition, which has an ordered list of CalculationSpecification objects. An AggregationSolve executes the aggregation operations specified by its AggregationDefinition objects in the order in which they appear in the list.

A CalculationSpecification can be either an Aggregation or a ModelRef. An Aggregation specifies the aggregation instructions for a hierarchical dimension. A ModelRef references a Model to specify aggregation instructions, typically for a non-hierarchical dimension such as a line item dimension.

Fields inherited from class oracle.AWXML.BaseObject

DATABASENULL

Constructor Summary

CalculationSpecification(BaseObject input)
Creates a new CalculationSpecification for the specified AggregationDefinition.

Method Summary

java.lang.String	Create(AWConnection connection) Creates the CalculationSpecification in the current analytic workspace of the specified database connection.
java.lang.String	getAggregationText(AWConnection connection) Gets the aggregation instructions represented by the CalculationSpecification.
int	getCalculationOrder() Gets the position of the CalculationSpecification in the list of CalculationSpecification objects of the owning AggregationDefinition.
void	setCalculationOrder(int input) Specifies the position of the CalculationSpecification in the list of CalculationSpecification objects of the owning AggregationDefinition.
void	setCalculationOrder(java.lang.String input) Specifies the position of the CalculationSpecification in the list of CalculationSpecification objects of the owning AggregationDefinition.
java.lang.String	WriteToXML() Gets an XML representation of the CalculationSpecification.

Methods inherited from class oracle.AWXML.BaseObject

Alter, CreateAfter, CreateBefore, CreateFirst, DataRead, Delete, getColumnName, getId, getLongName, getLongName, getName, getOwner, getPluralName, getPluralName, getSchema, getShortName, getShortName, setColumnName, setLongName, setLongName, setName, setPluralName, setPluralName, setSchema, setShortName, setShortName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CalculationSpecification

public CalculationSpecification(BaseObject input)

Creates a new CalculationSpecification for the specified AggregationDefinition.

Parameters:

input - The AggregationDefinition to own the new CalculationSpecification.

Method Detail

setCalculationOrder

public void setCalculationOrder(int input)

Specifies the position of the CalculationSpecification in the list of CalculationSpecification objects of the owning AggregationDefinition.

Parameters:

input - An integer that specifies the position of the CalculationSpecification in the list of CalculationSpecification objects.

setCalculationOrder

public void setCalculationOrder(java.lang.String input)

Specifies the position of the CalculationSpecification in the list of CalculationSpecification objects of the owning AggregationDefinition.

Parameters:

input - A number as a String value that specifies the position of the CalculationSpecification in the list of CalculationSpecification objects.

getCalculationOrder

public int getCalculationOrder()

Gets the position of the CalculationSpecification in the list of CalculationSpecification objects of the owning AggregationDefinition.

Returns:

An integer that identifies the position of the CalculationSpecification in the list of CalculationSpecification objects.

WriteToXML

public java.lang.String WriteToXML()

Gets an XML representation of the CalculationSpecification.

Overrides:

WriteToXML in class BaseObject

Returns:

An XML String that represents the CalculationSpecification.

getAggregationText

public java.lang.String getAggregationText(AWConnection connection)

Gets the aggregation instructions represented by the CalculationSpecification.

Parameters:

connection - The AWConnection that represents the database connection.

Returns:

A String that contains the aggregation instructions.

Create

public java.lang.String Create(AWConnection connection)

Creates the CalculationSpecification in the current analytic workspace of the specified database connection.

Overrides:

Create in class BaseObject

Parameters:

connection - The AWConnection that represents the database connection.

Returns:

A String that contains success if the method successfully creates the CalculationSpecification.